fix: allow services to indicate their dependencies #1762
Conversation
Some services depend on others, for example circuit relay v2 and kad-dht don't really work without identify so we need a way to prompt the user to configure these dependencies. The change is to allow extending the components a service requires with a service map of the dependencies. The components type in the `Libp2pInit` type is extended by the `ServiceMap` generic type so when the user configures a node without the required dependencies, TypeScript will fail to compile as the components being passed to the factory function don't have type overlap with the required components.
| @@ -17,6 +18,7 @@ describe('circuit-relay discovery', () => { | |||
|
|
|||
| beforeEach(async () => { | |||
| // create relay first so it has time to advertise itself via content routing | |||
| // @ts-expect-error TODO: typescript cannot infer the service map type | |||
There was a problem hiding this comment.
I am not sure why TypeScript can't infer this, it seems to work elsewhere.
|
Super cool! This does feel like it gets close to the line where TypeScript stops being fun anymore... once you start playing the generics game it's hard to stop. Personally I love going crazy with types but it can start to slow people down; it's up to you to weigh those tradeoffs. Just a thought: if the idea is that "we have some components that get passed around, which always include certain built-in components, ", then would changing everything to take a Edit: I guess the other question hanging over this is that the services refactor kinda suggests that people can name their services anything they want now, but in reality dependent services still rely on specific names. Maybe make sure this is communicated in the docs somewhere? |
achingbrain
changed the title
That's a good point @joeltg , the original impetus to even have these optional services was to reduce Libp2p surface area in consumers and also to improve extendability through custom modules. I think at the time we went with the I think having the
Whilst we do now support custom modules I agree the docs should reflect those constraints, perhaps we could have a section in the configuration doc where we indicate that some services require others e.g. setup with relay requires identify ? I opened an issue for further discussion. |
|
Discussion: #2135 |
|
I'm going to close this in favour of the solution proposed in #2135 |
Some services depend on others, for example circuit relay v2 and kad-dht don't really work without identify so we need a way to prompt the user to configure these dependencies.
The change is to allow extending the components a service requires with a service map of the dependencies.
The components type in the
Libp2pInittype is extended by theServiceMapgeneric type so when the user configures a node without the required dependencies, TypeScript will fail to compile as the components being passed to the factory function don't have type overlap with the required components.